Warehouse adapter — 3PL Central
The adapter
object contains properties for connecting to the 3PL Central API.
Parent object: a warehouse with property "platform" : "g3pl_central"
Required properties
The following adapter
properties are required for 3PL Central warehouses.
client
Property | client |
Name | 3PL Central API Key |
Data type | string |
Example | "012-34-567-890" |
Required? | Yes |
client_secret
Property | client_secret |
Name | Customer Secret |
Data type | string |
Required? | Yes |
customer
Property | customer |
Name | Customer ID |
Data type | string |
Required? | Yes |
tpl_key
Property | tpl_key |
Name | 3PL Central API ID |
Data type | string |
Required? | Yes |
user_login
Property | user_login |
Name | Customer Login |
Data type | string |
Required? | Yes |
Optional properties
The following adapter
properties are optional for 3PL Central warehouses.
account_number
Property | account_number |
Name | Account Number |
Description | FedEx or UPS Account Number |
Data type | string |
api_version
Property | api_version |
Name | 3PL Central API Version |
Data type | string |
Accepted values | "SOAP (Version 1)" "REST (Version 2)"
|
Default | "SOAP (Version 1)" |
carrier_billing_code
Property | carrier_billing_code |
Name | Carrier Billing Code |
Data type | string |
Accepted values | "Prepaid" "Recipient" "USPS Third Party" "FedEx Third Party" "UPS Third Party" "Collect"
|
Default | Prepaid |
carrier_billing_postal_code
Property | carrier_billing_postal_code |
Name | Carrier Billing Postal Code |
Data type | string |
facility_id
Property | facility_id |
Name | 3PL Central Facility ID |
Description | Numeric ID of the 3PL Central facility |
Data type | integer |
Default | 1 |
include_package_details
Property | include_package_details |
Name | Include Package Details |
Description | Send shipment data to sales platform at line item level |
Data type | boolean |
Default | false |
local_zone
retailer_id
Property | retailer_id |
Name | Retailer ID |
Data type | Customer Retail ID |